home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Night Owl 6
/
Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso
/
029a
/
sclip.zip
/
SCLDOC.FW3
(
.txt
)
< prev
next >
Wrap
FrameworkDocument
|
1990-07-23
|
81KB
|
1,425 lines
scldoc
Scan & Clip<return>Instructions
July 10, 1990
<page>
Scan & Clip (version 1.00) is a Fred program that scans most
types of frames for words that you choose, clips those "hits"
(along with an
adjustable
context block of surrounding lines) to
another report frame, thus, producing a report that consists only
of the parts of the original document in which you are
interested.
Scan & Clip is intended to be a document (or program)
analysis
tool, not merely a text retrieval program.
Originally, this program was designed as a legal practice
tool; to scan large deposition text files received from the court
reporter on disk as ASCII files, that are simply loaded on the
desktop and scanned without modification. Sub-versions of each
deposition can be produced on different aspects of the case. The
program now has been expanded to cover a wide variety of frame
types.
I also use Scan & Clip to analyze long FRED formulas. It
helps me debug and tighten up, say to bring together every time I
use a particular variable, with cross references to the original
formula line where each hit can be found in the original.
The primary types of Framework Frames can be scanned. Most
varieties of nested outline frames can be searched; on formulas,
labels, and text !
Batch operation options allow several separate documents to
be searched in one batch (e.g. search all the depositions in a
particular case in one batch). The batch mode can search frames
on the desktop or load them from disk, one at a time (Thus, the
total, aggregate frame size that can be scanned in a batch can
exceed available desktop RAM).
Scan & Clip is text oriented. But modules for spreadsheets
and databases are included.
;{F9} to read
Short Description
Installation
AUTO INSTALL -
If you already have not done so, you can
automatically install the macros and program by loading the file
named "SCLins.fw3" to the desktop, placing the cursor on the
frame, and recalculating it by pressing {F5}. You will be
instructed and prompted from there for a safe, fast install.
*** Install ends with some very basic instructions for a quick
trial run. Note: all that is installed in your Library is a
small
invoking
macro (SCLaltm.fw3), which when invoked, in turn,
brings the real program (SCLprg.fw3) to the desktop, if it is
not already on the desktop. (see below).
THE FIRST TIME
that SCLaltm (renamed {Alt-S}) is invoked it,
in turn, installs SCLprg in your Library (without deleting
SCLALTM or renaming either module) . See Sections 3.2.1 below
See Special Topics - Screen Display, if you do not like the
display that appears on your monitor.
or.
ur monit
;{F9} to read
Automatic
MANUAL INSTALL -
1. Copy all SCL prefix files (e.g. SCL*.*) to your FW3
default drive and directory.
the included macro (
SCLaltm
into your Library
SCLaltm is the macro that is called by an ALT-KEY combination.
Rename SCLaltm to the {Alt-key} combination that you desire (I
use {Alt-S} -- the auto install program stores SCLaltm in your
Library as {Alt-S} and renames any pre-existing {Alt-S} as "old
alt-s"). SCLaltm calls (or installs and calls see Section 3.1
below) the real program, SCLprg.fw3, which is about 64K.
3. A.
THE FIRST TIME
that SCLaltm is invoked (i.e. by
pressing {Alt-s} it, in turn, installs SCLprg in your Library
and (without deleting SCLALTM or renaming either module) passes
control to SCLprg, until SCLprg is manually deleted from your
Library.
B. This procedure: [1] Avoids permanently burdening your
Library and Ram with a large program that you probably will use
in concentrated periods, rather than randomly; but [2] Leaves
the main program on the desktop after it is initially invoked
(thus, avoiding the delay of loading a 64K program for each
document scan).
C. When a session is completed, manually delete SCLprg
from your Library
simply do not save your Library when you
quit (unless you want it to continue to reside there). BUT LEAVE
SCLALTm (which, by then, would have been renamed to an {alt-key}
combination).
RAM is not a concern, you may want to leave
SCLprg permanently in your Library when you save it.
D. SCLALTM installs SCLprg in your Library, rather than
on the desktop, in order to avoid some very complicated path
names that would be necessary. SCLprg will NOT run from your
desktop, except IN your Library.
4. See Special Topics - Screen Display, if you do not like
the display that appears on your monitor.
Manual
Operating Instructions
The program should be invoked by a macro
, preferably, the
included macro; e.g. {Alt-S}. The suggested macro is included as
SCLALTM (to be renamed as a ALT KEY combination, such as
{Alt-S}). See Section on Installation.
To scan and clip a document, SCLprg (to be renamed) is
expected to be stored in your Library, but it need NOT be stored
there when {alt-s} is pressed.
If it is not stored in your Library (to conserve Ram), the
SCLaltm (renamed) will load it into your Library for that
session.
SCLaltm ALWAYS should reside in your Library.
;{F9} to read
Invoking the program with the included macro
Using the program
You initiate Scan & Clip by pressing an Alt key
combination. You can set the Alt key combination to any one you
wish, but, for convenience,
this documentation will assume that
you have chosen {Alt-S}. All references to {Alt-S} in this
documentation will refer to the particular Alt key combination
that you choose.
When you press {Alt-S} one of two things will happen.
If you have stored the main program (SCLPRG) in your
Library
, then pressing {Alt-S} will immediately run the program
and present you with the Scan & Clip menu (see below).
If, however, for whatever reason, including conservation of
Library
space, you have chosen not to keep the main program in
your Library
, then pressing {Alt-S}, at any time when SCLPRG is
not resident in your Library, will load SCLPRG from your hard
disk and install SCLPRG in your Library
. Once installed, SCLPRG
will remain in your Library until you manually delete it or do
not save Library
at the end of session.
If the main program (SCLPRG) is not in the Library
when you
press {Alt-S}, then the program will not run on that pressing,
but will respond with a message to the effect that the program
has been installed in your Library. Then (once the main program
has been temporarily installed in your Library), the next time
you press {Alt-S} the program will run.
See Section 2.2 for the reason for this routine, which,
primarily, is to allow a particular user not to dedicate the 64K
required by SCLPRG to the storage of this program in RAM when it
is not in use.
Pressing {Alt-key} to start
In order to properly run, the cursor MUST be properly placed
when you press {Alt-S}.
The required placement of the cursor
varies depending on the type of frame being searched and the type
of search
. The proper cursor placements are:
(1) a word, text frame, spreadsheet, or database,
contained in an outline or containing frame
: Cursor
can be inside the document or on the frame label. NOTE: SEARCH
DATABASES in "table view", i.e. row/column;
(2) Formulas,
not in outline or containing frame:
formula must be zoomed so that it fills the whole screen and the
cursor should be at the {ctrl-home} position of the zoomed
formula;
(3) Outlines of
type: Cursor must be on the frame label
of the outer most containing frame;
(4) Batched, desktop: Cursor should be on the first (i.e.
top) frame. No frame should reside (graphically) below the last
frame in the batch;
(5) Batched, disk: Cursor should be in the open file disk
cabinet with the cursor placed on the first (i.e. top) frame to
be batched, loaded and scanned. No frame should reside
(graphically) below the last frame in the batch.
batch.
Required cursor placement
before
pressing
{Alt-Key}.
VERY IMPORTANT.
sor pla,
If you press {Alt-S} after SCLPRG is installed in the
Library (see above), you immediately will be presented with a
three choice menu on the prompt line. The three choices are:
[S]can, [C]hange or view Setup, or [Q]uit.
To change or view the current defaults for the next document
to be scanned, press "C" or cursor to the "Change or view Setup"
option and press {return}. Then, you will be presented with the
Set-up menu. See Section 4 below.
To scan a document and generate a report, press "S" or
choose the "Scan" menu choice with your cursor and press
{return}.
First menu choice, to scan or set or view options
Changing or viewing options
When you press {alt-s} (assuming that it has been
initialized, see Section 3.2.1), you are presented in the prompt
line with a menu choice of: Scan, Change or view Setup, or Quit.
If the situation in which you invoked {alt-s} permits (see
Section 4.4.6), along with this initial menu, the currently
effective settings for
of the key program variables/options
are displayed, so that you can more conveniently determine
whether you need to change the Setup settings.
To change the Setup settings "on the fly" for scanning that
and all subsequent documents (until reset), choose "Change or
view Setup". You then will be presented with a
full screen
menu.
This Change or view Setup sub-menu is mirrored in Section
4.4 of this documentation (to which you should refer). Several of
the first level choices, in turn, lead to additional sub-menus.
To select (and change or merely view) a particular setting
or menu choice, use the arrow keys to place cursor on it and,
then, press {return} (if,
and only if
, the menu choices begin
with a unique first letter, as they do on the first level, a menu
choice also can be chosen by pressing the first character of the
menu choice in question).
If the particular menu choice, in turn, contains nested menu
choices, then pressing {return} will bring up the next level
menu. If the particular menu choice is, itself, a default
variable setting choice, then when, you press {return}, you will
be presented with a data entry prompt.
In the latter situation, the prompt line will contain the
"permanent" default for that particular setting and the prompt
line message will show the "current" setting. (See Section 4.2
for an explanation of the quoted terms). You can press {return}
to accept the "permanent" setting or you can enter any valid
entry for that particular variable.
Choose Quit, when finished. The entered changes will remain
"current" until changed. The "permanent" setting will not be
affected. (See Section 4.3.2 for instructions on how to change
"permanent" settings).
ings).
On the fly, for a particular document
See Section 4.
To reset to the "permanent" defaults, choose "All reset"
from the "Change or view Setup" menu.
menu.
Resetting to defaults
Scanning
After you choose to scan, then you will be presented with
one, two, or three additional prompts (depending on optional
settings).
You will be presented with the first prompt in all cases
(search criteria), you will be presented with the second prompt
(size of context block), only if you have this option toggled for
this prompt. See Section 4.4.2.1 below.
If you are scanning an outline (containing) frame you will
be presented with the third prompt (identify what in the outline
to search), only if you have this option toggled for this
prompt. See Section 4.4.5.1 below.
After you enter an appropriate response to the prompt, the
program will proceed automatically from there and will
periodically report its progress.
If you batch scan a group of documents, either from the
desktop or from disk, then the input at the first two prompts
will be applied to each document in the batch.
That is, you
cannot batch scan documents for different search terms or with
different context blocks. However, you
batch scan different
outline types (by requiring a prompt to indicate type, for each
document in the batch).
Library
Overview
At the first prompt, enter the search criteria. The search
criteria can be any valid Framework search phrase, including wild
cards.
For further information on valid Framework criteria, see
pages C2 & C3 of "Using" FW3 documentation and the files called
DBSRCH.ART AND WILDCD.ART in Lib. 10 CIS Ashforum.
For example, enter "Smok*" (without the quotes) to search
for all words with the root "smok".
The {ctrl-l} menu choices can be set before a scan, to
further refine a search. E.g. "Ignore Capitalization", off or on.
or on.
Entering search term
If the second prompt is toggled on (prompt for context
size), enter an Arabic number. The number chosen will be the
number of lines above and below the hit which will be captured
in the generated report along with a hit, to give the hit
context.
The number can be as low as zero and as large as the page
size. As a practical matter, 2 to 8 is recommended. As explained
in the Special Topics Section 6.9 below, in some circumstances a
context block of zero (0) can cause a problem.
If you are searching a frame that is double-spaced
on the
screen
(it is not relevant how it is spaced on the printed
document) you must remember to double the context block you
intend. For example, choosing a context block of one in a double
spaced document (on the screen) will clip the hit line only,
because one line above and below the hit line will be empty.
Entering size of context block
General
Scan & Clip offers you the option to batch scan several
files and documents that reside on your hard disk or desktop.
The disk batch option is especially useful if the several files
that you desire to batch scan would, in the aggregate, be too
large for the available RAM on your desktop.
NOTE: The formula area can be batch scanned
as part of
and contained in an outline. Individual, separate frames can not
be scanned for their formulas, in the batch mode.
In the Setup menu, there is an option to toggle batch scan
on and off. A separate option in the same Setup sub-menu lets you
choose to batch scan from the desktop or hard or floppy disk.
Batch Scans From Disk
The disk batch option loads designated files from your
designated disk, one at a time, scans them, creates a report of
clips (hits), and deletes from the desktop (not from the disk)
the scanned original document before loading the next document to
be scanned.
You can scan from any available drive. The cabinet for the
disk must be open and contain only the files to be batch scanned,
by filtering the cabinet (or by storing the target frames in a
unique sub-directory).
To begin the batch scan, when {Alt-S} is pressed, the cursor
be on the top frame (i.e. on the first of the files to be
batch scanned). There should be no frame located (graphically)
below the last frame in the batch. With the cursor so placed and
with the proper batch settings in the Setup menu, simply press
{ALT-S} and each file will be loaded to the desktop and
scanned.
NOTE: Because you must instruct the program on
it is
inside an outline frame that you wish to scan (formula, label or
text), as each file in a particular batch is addressed for
scanning,
either
you must answer this prompt for each outline
that is, in turn, addressed for scanning,
you must use the
Setup option in the Setup outline sub-menu to toggle off this
type of outline scan prompt so that the program skips this prompt
and selects, by default,
in the outline is to be scanned.
If you choose this toggle (i.e. turn off this prompt), then you
must, again by menu choice in the Setup outline sub-menu, set,
for all the frames to be batch scanned, what in the outline frame
you wish to be batch scanned. If you choose this option, then
only outline attributes of the same type can be successfully
batched. I.e., if this toggle is chosen, you cannot batch scan
three different attributes of outlines, one for labels, one for
formula and one for text. If you want to do this (i.e. mix
attributes), leave the prompt toggle on and, as each frame is
loaded to the desktop to be batch scanned, be prepared to answer
this prompt. See Section 4.4.5.
, before
Batch scans
: To avoid needless repetition, some important
usage
tips and information on advanced features are contained in
Section 4, in describing the program options. Thus, the Setup
Section 4 should be read as an instructional aid, even if you do
not intend to change any of the original default settings.
Advanced features
t.n.j.V.
Setup : Changing program parameters
Of the 26 options in running Scan and Clip that can be set
from the Setup menu, each option has a setting with three
"permanency" characteristics; "original", "permanent", and
"current".
Probably, you will want to study this Setup section of the
documentation after you read Section 3.2 (Using the program) and
have made a few trial runs. The Setup options will be more
meaningful after you have used the program.
There are several variables that are desirable, indeed
necessary, to adjust for the characteristics of a particular
task. On the other hand, for each user these variables will
to remain constant, once originally set; as an example, the
number of lines per ASCII page that his or her particular court
reporter uses as a standard for a deposition page. Thus, it would
become burdensome to prompt for each of these variables each time
a document is scanned.
As a solution, the SCLprg outline contains a sub-frame
called "Setup", in which these several variables are nested. Each
can be changed and will remain applicable for future uses, until
again changed.
The Setup variables, which are user set, are to be
distinguished from the global variables shown in the SCLprg
outline frame, which global variables are program set. Scan &
Clip uses both.
Each of the Setup variables is described in this section.
The description of these variables contains several usage tips
and operational information that is not repeated elsewhere.
;{F9} to read
About the setup options
As mentioned above, each program option has three
"permanency" characteristics.
First, for each program option default, the program as
originally up-loaded contains an original setting that I set.
These are referred to as "the original defaults". If changed, you
can refer to this documentation if you desire to return to the
original default.
Second, for each option, there also is a "permanent" default
which is the default that is set in the spreadsheet frame called
"Setup Defaults", under the "Setup Modules" subsection of
SCLprg.fw3. It is nested below, but on an equal level with, the
sub-frame called "Setup Menu". If a "permanent" default is
changed (see Section 4.3.2 below), and if SCLPRG is saved after a
change of a "permanent" default, then the new entry will become
the new "permanent" default. It (the new change) will be
"permanent" until otherwise directly changed in the Setup
Defaults spreadsheet frame (See Section 4.3.2).
Third, for each option, there also is a "current" default
which is the default that is set for each variable contained in
the containing (menu) outline frame called "Setup Menu", under
the "Setup Modules" subsection of SCLprg.fw3. The "current"
default can be different from the "permanent" default.
"current" default is the setting that actually is used in program
processing
. It is changed "on the fly" as explained below.
Thus, for each program option, there are two active
defaults, with the "current" being the controlling setting for a
particular scan and with the "permanent" default preserved for
easy resetting after a particular scan.
The "current" default is the setting for each option that
will be processed the next time that Scan & Clip is run. These
can be saved from session to session and need not (but can) be
reset from document to document. So, in that sense they are
"permanent." However, if the spreadsheet frame that contains the
permanent options is recalculated,
or you choose the All reset
option from the setup menu, then all the current defaults will be
reset back to the permanent default
This structure should provide you with the greatest document
to document and session to session flexibility, while still
providing a quick way back to your particular generally preferred
settings.
As you read the description of the three types of defaults
and use them in actual practice, I think that you will see that
the three levels of "permanency" give the user considerable
flexibility in using the program with the minimum need to
customize each of the 26 options document-by-document, but with
the flexibility to do so when appropriate.
For example, 90% of your documents might be run with
mark-hit "on" and you would want your permanent default to be on.
However, on a particular day, you might have to process 6
documents with mark-hit "off". Rather than change the permanent
default, in that situation you would want to change the mark-hit
default from the setup menu and make "off" (N) the current
default which will stay active until either changed from the
menu, or "All reset" is chosen to return to the "permanent"
default ("on", in this example).
Current vs. Permanent vs. Original Defaults
Changing Defaults
Current
To set a new current default without changing the permanent
default, press {Alt-S} and, at the first menu prompt, choose
"Change or view Setup". You then will be presented with a
sub-menu that will have all of the Setup menu options sub-grouped
by categories (which correspond, in structure and organization to
Section 4.4 of this documentation). Choose the appropriate
category and press return. You then will be presented with a
sub-menu for all of the options within that sub-category. Place
the cursor on the particular option you want to change and press
{return}.
The prompt data entry line will show the permanent default
and the prompt line will show the current default. Thus, when
you choose an option from within the Setup menu you will see both
active possibilities ("current" and "permanent").
Of course, you
may choose to set a valid setting other than either default (as
long as the entry is valid for that particular option).
Whatever you enter will become the "current default". It
will replace the old "current" default. The permanent default
will not be affected.
NOTE: There are options that allow you to enter narrative
text, such as the contents of report notes. These entries may be
several lines. Obviously, all will not appear in the prompt
line. To enter a new multi-line setting for one of these
options, simply select the appropriate menu choice (see above),
zoom the edit line with {f9}, and enter and format as you wish.
When completed, zoom back to the single prompt line and then
press {return} to set the new current default.
cter, scr
Setting new current parameter
If you make several changes to the current defaults,
inevitably, you will want to get back to your normal options that
apply to most of your documents. To do so quickly, simply choose
the "All Reset" option from the setup menu and press {return}.
Doing so will return the "current" defaults for all options to
their respective "permanent" defaults.
Re-setting to permanent settings
To change a "permanent" default,
you do NOT use the Scan &
Clip menu. Instead,
manually
navigate to the spreadsheet frame in
SCLprg.fw3 called "Setup Defaults", under the "Setup Modules"
subsection of SCLprg.fw3. It is nested below, but on an equal
level with, the sub-frame called "Setup Menu".
Press {f9} to zoom
the spreadsheet called "Setup Defaults".
Press {ctrl-home}, if not in the first cell.
Inside you will see three columns. The far left hand column
contains an alias name for each of the options; the alias name
corresponds to the actual option name except that the alias name
begins with a "d", to differentiate it from the actual frame that
contains the currently active setting for each option. For
example, the frame that contains the currently active setting for
the toggle that controls whether to mark hits is called MHX and
its alias in the permanent setup frame is called "dMHX".
The second column contains the corresponding permanent
default. Again, for example, the original default (which will
be the first permanent default) for MHX is "Y, i.e. ON).
change a "permanent" default, you manually change the entry in
this column.
The third column contains a simple guide to the possible
valid entries for each default option.
There also is a fourth column that is hidden by sizing. This
hidden column contains the formula, that when recalculated,
resets the current active default back to the permanent default.
When the "All Reset" option is chosen from the setup menu,
all current defaults are reset to the permanent defaults
contained in column two of this spreadsheet, see above.
If you change a permanent default (by changing the entry in
the second column of the Setup Defaults spreadsheet frame), you
must save sclprg.fw3 to really make the change permanent
. If you
keep sclprg in your Library, simply save your Library. If you do
not, but install it only as needed (see Section 2.2), then you
will need to copy the current copy of sclprg that contains the
changes (which probably will be
in your Library) to the
desktop and save it to overwrite the sclprg.fw3 that is on your
hard drive.
Permanent
@menu(Setup Menu)
The Setup menu
L.6.&.
Report parameters
H.D.@.
Footnotes
The program allows two footnotes to be placed in the report.
One in the title and one in the legend that indicates the end of
the report. You can toggle on/off each or both or any one of
these.
PX1 toggles on/off the note that appears in the heading
title. PX2 toggles on/off the note that appears after the end of
report marker.
Of course, after a report is generated, you can move or
delete the program generated notes or add additional notes, by
using the FW3 footnote features. The two program generated
footnotes, reflect
perceived "standard".
The placement of the notes can be changed and additional
standard notes can be added by code modifications to the "Report"
module, under the "common modules" section of SCLprg.fw3.
The original default for PX1 is "Y" (without the quotes).
Change as explained in Section 4.3, above.
PX1 ; toggle report note #1
on(Y)/off(N)
This contains the text of footnote one that will be inserted
if PX1 is toggled on. By "zooming" the edit line, it can be made
multiple lines and the Word menu can be used to format it, as is
done with the original default, which is :
This report is confidential.
"
[formatted differently than appears above].
Change as explained in Section 4.3, above.
PN1 ; contents of report note #1
The program allows two footnotes to be placed. One in the
title and one in the legend that indicates the end of the report.
You can toggle on/off each or both or any one of these.
preceeding section on PX1.
The original default for PX2 is "Y" (without the quotes).
Change as explained in Section 4.3, above.
footno
PX2 ; toggle report note #2
on(Y)/off(N)
This contains the text of footnote two that will be inserted
if PX2 is toggled on. By "zooming" the edit line, it can be made
multiple lines and the Word menu can be used to format it, as is
done with the original default, which is :
Page cross references in this
report are calculated. When a
document is printed, page
breaks are affected by many
factors. The page cross
references in this report may
not correspond to the page
numbers of your particular
hard copy, either because the
calculation parameters were
improperly set or because of
the printing characteristics
of your document.
"
[formatted differently than appears above].
Change as explained in Section 4.3, above.
PN2 ; contents of report note #2
Document page description
As elsewhere explained, the generated report, cross
references each hit to the FW3 frame line AND a hard copy page
number. For actual use, especially by someone who did not
generate the report, the
description
of the hard copy is
important. A generic reference might be confusing.
For example, in my reports of depositions, I prefer to cross
reference to "deposition page 120", rather than "hard copy page
120". In a particular situation, you might even want to get more
specific, such as "Jones Report page 12". [Note: the ASCII frame
name for a deposition usually is the deponent's name, so the
cross reference to "deposition page" communicates, because the
report title includes the source frame name].
This reference is set by two setup variables; PR1 for text
frames and PR2 for database, spreadsheet, and formula frames. I
assumed that a particular user might have different "standards"
for each of these categories. For example, being a lawyer, I set
PR1 to "deposition page" (without the quotes) and PR2 to "hard
copy page" (without the quotes) .
For both PR1 & PR2 the original default is "hard copy page"
(without the quotes).
Change as explained in Section 4.3, above.
PR1 ; description source
hard copy for page cross
reference in report for
text frames
n sourc
See PR1, in the immediately preceding section.
For both PR1 & PR2 the original default is "hard copy page"
(without the quotes).
Change as explained in Section 4.3, above.
PR2 ; description source
hard copy for page cross
reference in report for
other frame types
Margin & printing attributes
As elsewhere explained, the generated report is presented on
screen after the scan is complete, ready for printing. Because it
is anticipated that SCLprg will be used on frames imported from
other software or ASCII conversions (like depositions), there is
no way really to know on what the margin settings for each line
will be. For example, an ASCII deposition imports with a right
margin of 255, which really messes up centering of the Scan &
Clip generated report title.
Therefor, before presenting the report to you on screen, the
program re-formats the right and left margin of the report.
The setting for each is dictated by ML and MR, respectively.
For lack of better means to guess your particular main use,
the original default for ML is "0" (without the quotes) and the
original default for MR is "80" (without the quotes).
Change as explained in Section 4.3, above.
ML; left margin width
See ML in the immediately preceding section.
For lack of better means to guess your particular main use,
the original default for ML is "0" (without the quotes) and the
original default for MR is "80" (without the quotes).
Change as explained in Section 4.3, above.
MR; right margin width
As elsewhere explained, the generated report is formatted
for printing after the scan is complete, to make it ready for
printing. Because it is anticipated that SCLprg will be used on
frames imported from other software or ASCII conversions (like
depositions), there is no way really to know on what the printing
width settings for each line will be, in relation to the screen
margin settings that you choose.
Therefor, before presenting the report to you on screen, the
program sets three printing format characteristics: a centered
footer for <page>, which I hope is non-controversial and
universally desired; and the offset and line width, which can be
changed by changing the setup variables (
OF course, before
printing the report, you can
manually
change ALL printing
variables from the FW3 Print menu
The setting for each is dictated by PO and PW, respectively.
For lack of better means to guess your particular main use,
the original default for PO is "0" (without the quotes) and the
original default for PW is "80" (without the quotes).
Change as explained in Section 4.3, above.
PO; printing offset
See PO, in the immediately preceding section.
For lack of better means to guess your particular main use,
the original default for PO is "0" (without the quotes) and the
original default for PW is "80" (without the quotes).
Change as explained in Section 4.3, above.
PW; printing width
When searching a document that is loaded on the Framework
desktop after it has been converted from another format, you may
import into the new (converted) document the ASCII new page codes
that are sent to the printer to make it eject a page. That is,
ASCII characters 012 may appear in the document
and Scan & Clip
report
(if it appears within the context block of a hit).
If so, when you try to print out the generated report, the
ASCII character 012 will be sent to the printer and cause an
undesired new page and page eject.
For a document without these codes or in a rough-cut
situation, the program execution time needed to remove these
codes is unnecessary and you might not particularly care whether
the page codes are imbedded or not. However, if you desire to
print the document and circulate it, you probably will want to
eliminate any ASCII 012 codes.
This option, DPCX, is a toggle for deleting these ASCII 012
codes,
from the generated report, NOT from your source frame.
save you from the time necessary to manually delete the codes, if
you are going to process all or several of your documents that
would contain such codes, you probably will want to toggle this
option on. If toggled on, the program will automatically remove
all ASCII 012 codes from the generated report(s).
The original default for DPCX is "N" (without the quotes);
i.e. "off" ASCII page codes will not be removed.
Change as explained in Section 4.3, above.
rogram
DPCX ; toggle delete ASCII page codes
from report, on(Y)/off(N)
PCX ;
2~2z2
cription
Hit marks
Unless this option is toggled off the Scan & Clip report
that is generated highlights the "hit" criteria each time that it
appears in the report (your original source frame is not
changed). For example, if searched on "Tom", each time "Tom"
appears in the report, it will be highlighted. For some people,
this makes reading the report much easier.
On the other hand, the highlighting process requires
significant processing time; only just about one order of
magnitude less than the rest of the program! You may want to gain
speed at the price of eliminating this feature, especially if the
highlighting does not contribute to your purposes. (See Section
4.4.1.4.2, for a compromise alternative to either on or off).
Highlighting can be toggled off by changing MH to any text
character other than a "Y". Of course, using a "N" will help you
remember.
To toggle back on, change MH to a "Y" (without the quotes).
The original default is "Y"; i.e. highlighting on.
Change as explained in Section 4.3, above.
MHX ; toggle whether to highlight hits
in report, on(Y)/off(N)
MHX ; t
This toggle chooses between two alternative methods by which
the program marks hits in your report. One ([R]egular) makes a
better presentation. The other ([Q]uick) is much faster, but the
presentation is not polished.
Regular is chosen by setting this option to "R" (without the
quotes). Quick is chosen by setting this option to "Q" (without
the quotes).
Regular locates each occurrence of a hit that is contained
in the report and highlights each individual hit in the report
with the chosen hitmark. It highlights the complete word that
contains the matching character(s). However, this marking process
takes 75% or so of the same processing time for the clipping part
of the program. For a report with numerous hits, it can be
significant.
Quick simply replaces all occurrences of hits in a report
with the search term reformatted to match the chosen hitmark.
Rather than a loop that loops a number of times equal to the
number of hits, Quick is a one step process. It is much faster
than Regular, but the generated report is not as clean.
Although the two methods may sound the same, they produce
different results.
First, when Quick replaces, it is literal. This is best
illustrated by an example: If you search on "smok*", it will hit
on "...caused by smoking..." and the report will so read; but
when the hit is marked by the
Quick
method it will be changed to
read "...caused by
smok*
ing..." (assuming that the hitmark is
bold). In the same example, marking by the
Regular
method will
read "...caused by
smoking
...".
Second,
and this is important to know
, Quick formats the
hitmark from the Replace ({ctrl-l}R) edit line. This means that
the hitmark is limited to the one letter formatting choices
available on the edit line, being [B]old, [U]nderline, [I]talic,
[S]trike Through, [L]owered subscript, and [R]aised superscript.
The Regular marking methods formats from the document, which adds
[A]ll Caps, [I]nitial Caps, and [N]o Caps, as additional possible
hit marks. As another consequence, the choice between Quick and
Regular also affects the entry for "HITMARK" (next section) that
is necessary to effect a particular format. E.g. to select Raised
superscript, HITMARK must be set to "R", if Quick is on, but to
"WR", if Regular is on.
The original default is "R"; i.e. Regular highlighting
method.
Change as explained in Section 4.3, above.
MHO ; [R]egular marking method or
[Q]uick mark
If MHX is on (Y), as explained above, the "hits" are
highlighted
in the report
. The source document is not
highlighted. The original default method of highlighting is by
BOLDING
each hit.
The method of highlighting can be changed to be any text
option that can be set from the FW3 Words menu. The setup
sub-frame called HITMARK must contain the letters necessary to
choose the intended highlighting feature AFTER {ctrl-W}. (see
below and previous section if MHO is set to [Q]uick).
For example, "B" (without the quotes), to set for bold. Some
other examples are as follows:
Underline : U
Italic : I
All Caps : WA
Superscript : WR
Subscript : WL
The choice between Quick and Regular marking methods also
affects the entry for "HITMARK" that is necessary to effect a
particular format. E.g. to select Raised superscript, HITMARK
must be set to "R", if Quick is on, but to "WR", if Regular is
on. See previous Section.
The original default is "B"; i.e. highlight by bolding.
Change as explained in Section 4.3, above.
HITMARK ; method of highlighting hits
Context block parameters
The Scan & Clip report that is generated includes the "hit"
criteria
a block of lines above and below each "hit", to
give the "hit" context.
How many lines above and below a "hit" that is predictably
necessary to give context will vary between documents. E.g. one
line above and below a database "hit" probably will be enough (as
it will capture three complete records), but five or more lines
might be advisable in narrative word documents (especially if
double spaced on the screen). Because the size of the ideal block
will vary, the original setting for this option prompts for the
block size.
On the other hand, a particular user may tend normally to
use this program on one variety of documents, for which the ideal
context block is the same. After becoming familiar with the
operation of this program such a user will find the blocksize
prompt to be unnecessary and tedious.
Prompting for the size of the context block can be toggled
off by changing BSPX (which stands for block size prompt) to any
text character other than a "Y". Of course, using a "N" will help
you remember.
To toggle back on, change BSPX a "Y" (without the quotes).
The original default is "Y"; i.e. prompt on.
Change as explained in Section 4.3, above.
BSPX ; toggle user set block size by prompt,
on(Y)/off(N)
As explained in the previous section, the Scan & Clip report
that is generated includes the "hit" criteria
a block of
lines above and below each "hit", to give the "hit" context.
IF prompting for the size of the context block is toggled
OFF as explained in the previous section, THEN the context block
size will be controlled by the value set for the setup variable
"BSPn".
The original default is "6" (without the quotes); i.e. For
each "hit", 13 lines will be clipped, the line in which the hit
occurs and 6 lines below and above the line of the hit.
The size can be as low as 0 (zero).
The original default for BSPn is "6" (without the quotes).
Change as explained in Section 4.3, above.
BSPn ; size of block default, if BSPX off(N)
The program "hits" and clips to the report frame every
instance of hitting the search criteria.
Because the report includes not only the frame line of the
"hit", but also a context block below and above each "hit, the
same "hit" can appear several times in a report.
For example :
Bob loves Sue
Sue Loves Bob
Tommy
Sue
With context block size set to three, a search of "Sue" (assuming
the above is single spaced on your screen) will show "Bob loves
Sue" 3 times; once as a hit, once as part of the context block
with a hit on "Sue loves Bob", and once again as part of the
context block with a hit on the last line "Sue".
Sometimes this repetition is desirable (it is, at least,
doggedly thorough) and sometimes it is not.
When you want to eliminate reporting of subsequent "hits"
within a chosen close proximity of a preceding "hit", set BPX to
on (Y).
This will ignore a subsequent "hit" that occurs within a set
number of lines after a particular "hit"; the number of lines
being set by BPn (see next Section).
The original default for BPX is "N" (without the quotes).
Change as explained in Section 4.3, above.
above.
BPX ; toggle avoid close proximity hits,
on(Y)/off(N)
If BPX is set on (Y), to eliminate close proximity "hits",
then BPn is activated. The setting for BPn determines the line
proximity in which subsequent hits will be ignored.
The setting may be less (or if you are daring, more) than
the size of the context block. If BPX is on (Y), then the program
will not separately hit on any search criteria that may appear
BPn lines thereafter. (But the ignored data will appear as part
of an earlier context block as long as the size of the context
block equals or is larger than BPn)
E.g Context Block set at 4 and BPn set at 3 - search on
"SUE" (assume the following appears single spaced on your
screen):
1. Bob loves Sue
2. Sue goes to school
3. Tommy is a fireman
4. The teacher likes Sue
5. Mike's dog is black
6. Sue is pretty.
Lines 1-5 will appear in the report on the "hit" of "Sue" in line
1. But "SUE" will not reappear as a hit on its own in lines 2 and
4. The next "hit" separately shown as a "hit" will be line 6,
which will show lines 2-6 as part of its context block.
The original default for BPn is "2" (without the quotes).
Change as explained in Section 4.3, above.
BPn ; size of close proximity range if BPX
on(Y)
Page parameters
As elsewhere explained, the generated report cross
references each hit to the FW3 frame line AND a hard copy page
number. Because it is anticipated that SCLprg will be used on
frames of hardcopies that are the product of other software or
ASCII conversions (like depositions) and an infinite combination
of FW3 screen and print options, there is no way really to know
on what original hardcopy page a particular hit will appear.
(SEE ALSO, Special Topics heading "Page references").
LP is a setting that is crucial for accurate hard copy
page reference calculations.
To be accurate LP must be determined and reset (if necessary)
for EACH Document that is scanned
To know how to set LP for your use, you must understand the
method used to calculate the hard copy page numbers.
The program calculates the hard copy page with the following
formulas:
1. "
pp:=@business(@ceiling((@panel2+pf)/lpp),0),
"
2. If the frame is an outline, "pf" is a running total of the
total frame lines up to a particular "hit" in question,
calculated, thusly:
"
@if(IFT=5,@list(
@pk("{out}"),
@echo(#on,2),
@echo(#off),
@pk("{in}"),
pf:=TL-lpf, ; Tl-lpf, resulting in said determination
@pk("{in}{f9}")),
"
Otherwise, "pf" is 1.
3. "lpp" is the crucial variable, which is calculated by :
"
lpp:=@VALUE(LP), "
"lpp" is "crucial", because it is set, by the user, outside of
the program. The program senses or calculates the other
variables. If "LP" is is wrongly set
for the particular document
being scanned
, the resulting page calculation will be wrong.
Obtuse as that explanation is, the bottom line is that LP
should be set to equal the number of frame
(i.e. screen)
lines
per printed page of the source frame
. Perhaps this is best
illustrated by an example, again by reference to my main use,
ASCII output of a deposition.
In our area and with our firm's main court reporter service,
ASCII output of a deposition is standardized as follows. Each
printed page contains 25
numbered
lines of text, with an empty
line in between (i.e. double spaced). Unlike some imports, the
double spacing shows as such on the FW3 screen (so you count the
blank line). Counting the top and bottom margins, when on my FW3
desktop, as an ASCII file loaded without conversion or
modification, each printed page of a deposition translates to 64
FW3, on screen,
right panel
indicated, lines. For such a
deposition, I set LP to "64" (without the quotes).
On the other hand, a DW4
double
spaced document that was
converted to ASCII, then to Wordperfect, and finally then
imported to FW3, appeared on my FW3 screen as 26
single
spaced
lines per printed page. Therefore, for that document (a long
contract), I set LP at 26.
For lack of better means to guess your particular main use.
the original default for LP is "54" (without the quotes), which
is the correct number for a single spaced FW3 document,
as I have
my printing defaults setup.
NOTE:
An incorrect setting for LP is not as fatal as it may
sound. Even should the setting be incorrect and the generated
report cross-references be in error, the page cross-references
can be manually corrected in the generated report by using the
normal FW3 word processing features.
Change as explained in Section 4.3, above.
LP ; screen lines per page of hard copy
Batch operation options
To facilitate project analysis, this program allows several
batch options. BATX toggles on(Y) and off(N), batch operation. If
it is off(N), the other batch choices are not relevant.
To illustrate : Say you have 11 contracts that were part of
the closing of a particular deal. You wish to terminate the
relationship. You might want to batch scan all 11 contracts for
"<term*>". Another illustration : There are several depositions
in a case, you may wish to batch scan all of them for "<rain*>"
to get a comprehensive report on all the testimony about whether
it was raining.
The original default for BATX is "N" (without the quotes).
Change as explained in Section 4.3, above.
BATX ; toggle multi-frame batch operation
on(Y)/off(N)
There are two basic types of batch operations; a particular
set of frames on the DESKTOP (FW) or a particular set of frames
on DISK (D) (hard or floppy). [tip - scanning sub-frames in an
outline also is a method of batch scanning; the only method for
batch scanning the formula area of frames.
This option chooses which method to use ( See batch scan
instructions, Section 3.2.5.4).
Desktop is faster. Disk is more practical if the total size
of the documents to be scanned exceeds your desktop RAM.
The original default for BATT is "FW" (without the quotes),
for desktop.
Change as explained in Section 4.3, above.
s; a parti
BATT ; set type of multi-frame batch if
on(Y), disk(D) or FW desktop(FW)
T ; !
If you choose to batch scan (see above) you may also choose
to cause the reports to be automatically printed, without user
intervention.
This option toggles that choice on(Y) or off(N).
If on(Y), make sure that your printer is on and has plenty
of paper.
The original default for BATP is "N" (without the quotes).
Change as explained in Section 4.3, above.
alic : I
BATP ; toggle batch printing on(Y)/off(N)
Outline control
As you know, one of the great features of FW3 is that an
outline can hold ANYTHING, words, database, spreadsheet, formula,
or only labels (not to mention graphs). A great feature, but a
pain for a scan program.
The method and behavior of searching (and even copying)
varies significantly from frame attribute to attribute. Thus, if
the program encounters an outline, it must be told WHAT (in the
outline) to search (i.e. searching labels, text-contents, or
formula?). (See below, the program can handle pretty complicated
outlines, as long as it knows whether to search the text-content,
the label, or the formula).
NOTE: The contents of databases and spreadsheets contained in an
outline can
be scanned and clipped (to scan and clip these,
they must be non-contained, free-standing frames).
This option toggles on(Y) or off(N) whether you BYPASS the
prompt for
to search, or whether the program "assumes"
to search by default. BYPASS the prompt is ON., get the prompt is
OFF. If you almost always search an outline for the same type of
data, formula, for instance, you may want to avoid the prompt by
toggling OTX on (Y).
ALSO, if you batch scan several outlines of the same type,
you may want to toggle OTX on(Y), to avoid the necessity for
operator input for each document.
The original default for OTX is "N" (without the quotes).
Change as explained in Section 4.3, above.
ust be
OTX ; toggle bypass prompt control of
outline type, on(Y)/off(N)
OTX ; tA
If you choose to toggle OTX on(Y) and avoid the outline type
prompt, then OTT will control
, in the outline, you are
searching.
The possibilities are:
[T]ext - meaning
the word contents
of a
frame. You
can not search database and spreadsheet contents, if contained in
an outline.
[F]ormula - meaning the formula area of each contained
frame. E.g. I scanned all the sub-routines that make up SCLprg.
[L]abels - I often use large outlines with nothing but
labels, in chronologies, for example. This choice will scan the
labels and the context block transcends levels and depends solely
on line proximity.
For some applications, the scan of an outline can be used as
a batch process.
The original default for OTT is "T" (without the quotes),
for text-contents.
Change as explained in Section 4.3, above.
OTT ; set outline type to process, if OTX
on(Y): T/F/L
As you can change all the features, individually and on the
fly, you can end up with a smorgasbord of defaults.
This option toggles off and on whether the current
setting for certain key settings that affect program
operation
are displayed when you press {Alt-S}. The display occurs at the
initial Scan & Clip menu.
This is a handy reminder and helps let you know whether the
current settings need to be changed for the intended operation.
However, if you have a slower chip, this feature involves an
initial delay (barely noticeable on faster chips), thus, you are
given the option to toggle it off.
Note: because of FW3 rules, the settings will not display in
certain situations; e.g. if {alt-s} is invoked from a zoomed
formula.
The original default for Display Key Settings is "Y"
(without the quotes).
Change as explained in Section 4.3, above.
Display Key Settings
As you can change all the features, individually and on the
fly, you can end up with a smorgasbord of defaults.
Especially if you have set your "permanent" defaults to fit
your usual document format, it is helpful to get back "home" to
your permanent defaults.
Choosing this option resets all the above to their permanent
default, which may have been changed from their original
defaults. See Section 4.3, especially Sections 4.3.1.2 and 4.3.2.
4.3.2.
All reset (set all to "permanent" defaults)
Reports
After scanning is completed, the program produces a report
formatted for printing. The report, as generated, should be
sufficient in the majority of circumstances, for printing
without modification. In addition, as elsewhere herein
explained, the Setup options for the program allow several of the
key report parameters to be toggled on and off and changed.
In addition, on a case-by-case basis, the entire report can
be substantially modified after generated, by using the built-in
Framework word and printing options.
Although the generated report can be "final draft" quality,
the real intent is to generate a good "first draft" that can be
refined with FW3's other features
As generated
Under the Setup sub-menu (See above), is a sub-menu for
setting and changing printing attributes. These attributes can
be changed on a document by document basis, or permanently reset
as explained above. Some of these options will be more further
discussed in the following subsections of this documentation.
Changing report options
Once a report is generated, it is a Framework frame, a word
document. It can be modified in whole or in part manually, by
using the normal Framework word processing and printing options.
Portions can be deleted and substantial additions can be made.
All or part can be moved to a larger document.
Thus, should you forget, for example, to properly set the
page parameter calculations, the report can be checked against
the actual hard copy document and the page cross references can
be changed easily to be correct.
Modifying a generated report
Scans of certain frames, especially complicated outlines,
may result in a reporting glitch. This is rare.
Rare as they are, the most common among the rare is a
multiple flag for a hit; e.g. three hit #7 flags before actually
showing the hit. In my experience, the hit count remains accurate
and these multiple flags simply need to be manually deleted.
Glitches
The generated report is, itself, a document that can be
scanned by the Scan & Clip program. In some circumstances, you
may want to further refine your report to limit the hits to those
that match in another search term.
To do this, simply
the
generated report
with the more
limiting search criteria.
For example, a deposition in a benzene case might have
hundreds of references to "benzene" and you may decide you only
want references to both "benzene" and "smoking" that appear in
the same selected context block. To produce such a report,
simply scan the original document on "benzene". Then, scan the
generated report on "smoking".
Of course, a report produced this way will require cleaning
up with the word processing functions of Framework and the hard
copy page references will be totally off and not correspond to
the original document. (simply fix with Framework's word
processing features)
Scanning a Scan & Clip generated report
Special topics
The program was designed on a color VGA (graphics) and looks
good on it and my alternate color EGA (graphics) system and
laptop LCD (T1000SE). You may want to adjust color settings to
look good on your system.
I have not tried this program on a mono, character, screen.
Screen display
Although I have regularly and successfully scanned a wide
variety of frames, including complicated outlines, word frames,
formulas, databases, and spreadsheets, I also have run into some
glitches that I can only explain by machine configuration. For
an example, see the next Section.
My only suggestion if that happens to you is to check your
Frame, Word, and Locate settings to see if they might explain
the problem. (e.g. did you miss a "hit" because {ctrl-l}, Ignore
Capitalization, was set to "off"?).
I would appreciate a report of any glitches so I can
determine if it can be controlled or eliminated in subsequent
versions.
Scan or Clip or Report glitches and errors
Because WHAT in an outline you may desire to scan may vary
from contents, labels, or formulas, the program must be
instructed on what to search for. This instruction can come from
user input at a prompt or by a default instruction. See Sections
4.4.5 where this explained.
IMPORTANT NOTE: YOU CAN NOT SCAN & CLIP THE
CONTENTS
DATABASES AND SPREADSHEETS
IN AN OUTLINE.
Complicated, multi-level outlines can be scanned (but you
can not scan the contents of databases and spreadsheets
contained in an outline). For examples, both the contents of
this documentation and the formulas contained in the nested
sub-frames of SCLprg were scanned.
For some applications, scanning an outline can be used as a
method of "batch" processing a scan & clip project.
A report for an outline also varies : If the formula areas
are scanned, there will be a separate report for each sub-frame;
if contents or labels are searched, there will be one
consolidated report.
: Although I have regularly and successfully scanned a
wide variety of outlines for text, formulas, and labels, I also
have run into some glitches that I can only explain by machine
configuration. For example, if,
on my laptop
, I scan this SCLDOC
outline frame on its labels, the scan completes, but the report
format is garbled and does not correspond to the source
document. But if I scan the same frame with the same version of
SCLprg on my desktop at work I have no problem. Strange. My only
suggestion if that happens to you is to check your Frame, Word,
and Locate settings to see if they might explain the problem.
ERROR NOTE : Certain frame or sub-frame titles can cause
errors and scan to abort. E.g. Long frame names (over 160
characters). If this happens, simply rename and see if it helps.
Scanning Outlines
Formula areas can be searched, either for an individual
frame or for all sub-frames in a containing frame. Initial
required cursor placement differs for each type of formula
search. See Section 3.2.2.
This makes Scan & Clip a programming aid. E.g. search SCRprg
for all occurrences of the Global Variable HOMEG, in any
sub-frame. You can search a complicated program (with
sub-routines nested) as an outline [cursor on outer most frame
label, choose F when prompted for type of outline]. For example,
the many sub-frames of SCLprg were scanned on one pass.
Scanning Formulas
Scan & Clip was written from a text perspective. Further,
the built-in FW3 filter features decrease its usefulness on
databases. Nevertheless, I included database and spreadsheet
modules AND have found some practical uses.
Some examples
DATABASE : Search the "Task" field of my time and billing
database (which can not be effectively filtered), to find every
time I talked to Mr. "X" on any file matter;
SPREADSHEET : Search an amortization schedule to create a
report that shows the balance due as of May of every year, to
analyze the situation at each annual option to terminate under
the terms of a lease on the same property.
Databases should be searched in "table view", i.e.
row/column.
Note : The report for a database or spreadsheet scan will
show the row number for each hit as it appears in the database
or spreadsheet,
when scanned
Also note: The original screen and printing default setting
probably will have to be changed for databases and spreadsheets,
which, typically, are wider than text or formula.
POTENTIAL SPECIAL PROBLEM
Because of the manner in which FW3's search function works
in a database and spreadsheet, this version of Scan & Clip must
first copy the data to a temporary text file to search. This
created a special concern: A FW3 word frame can hold only a
limited number of characters.
The source frame may exceed that
which the temporary frame can hold.
The program senses such an
occurrence, so informs you and aborts. If this happens, your
source frame must be split (manually or by filtering) into
smaller parts, in order to Scan & Clip.
ALSO NOTE: THE CONTENTS OF DATABASES AND SPREADSHEETS CAN
SEARCHED IN AN OUTLINE.
TLINE.
Scanning databases and spreadsheets
The FW menu bar settings can be important and sometimes
explain (and fix) what at first appears to be a bug in the
program. For example, if you have Locate Ignore Capitalization
off, then your scan and clip will be sensitive to
capitalization.
This situation also is a desirable feature that allows you
to further customize a scan. Simply set the menu choices
before
a particular scan.
Many of the FW3 menus can effect a scan and clip session.
The main ones are Locate, Frames, and Words.
The effect of
Framework
menu settings
To avoid clutter and repetition, you may wish not to
duplicate "hits" that occur within some sub-range of the context
block that is captured on a prior "hit".
This is an option that can be selected from Setup and the
size of the range of excluded "hits" can be modified. See
Sections 4.4.2.3 and 4.4.2.4 above.
Eliminating close proximity hits
Several documents can be scanned at once, as a batch. The
documents to be scanned can reside on the desktop or floppy or
hard disk.
In addition to the batch options, a scan of an outline, in
some applications, can be used as a method of a batched scan &
clip project.
See Section 3.2.2 on required cursor placement and Section
4.4.4 on further batch options and instructions.
as a
Batch Scans
Under some circumstances setting the context capture block
to 0 (zero) can produce erroneous line report results
[WARNING] can corrupt the source document.
If you set context capture to zero AND there are characters
in line one (1) of the source document, THEN the first character
of line one of the source frame will be deleted. I did NOT fix
this known bug, Because [1] this is a rare circumstance and
because [2] the fix would have complicated ripple effects and
because
[3] without regard to this known bug, you should NEVER
save the
source
frame after a scan (if for no other reason than
to protect the source frame from some condition not encountered
by me)
I have deliberately left this bug in the program.
The work around is -- never save a source frame after a scan and,
if the line count is off, you can correct it with FW3's normal
word processing features.
Zero (0) capture context block
Especially when scanning outlines, program execution is
heavily dependent on the @setselection command. In the wrong
combination of circumstances, this can cause the program to abort
with an error.
Three of the most common:
1. Frame or label not named. The program senses and corrects some
instances of this, but not all. If your program aborts, check to
see that the scanned frame and sub-frames all have
discrete
label
names;
2. Frame or label name is too long (must be under 160
characters);
3. "Current Mode" // I am not sure what this, but in "Current
Mode", @setselection can not be used to select or change frames.
This APPEARS to be related to low memory. Usually, re-running
after memory restoration solves the problem. Or the file(s) being
scanned may be too large, which sometimes can be solved by a disk
batch scan.
Especi
"@setselection" errors
Sometimes a scan will produce an error condition that will
not go away and affects frames that, before, scanned correctly.
To solve this either re-boot without saving sclprg or Library.
Persistent "sudden" or unexpected errors
The main option that increases speed (but at the sacrifice
of presentation) is either to toggle off the option to highlight
hits in a report or use the Quick method of highlighting, see
Sections 4.4.1.4.1 and 4.4.1.4.2.
Toggles that increase speed
Page references are calculated. Especially if the relevant
calculation factors are not properly sensed or set, the page
calculations can be off. But, if everything is set properly for
the particular document to be scanned, I have found the page
references to be very accurate.
See Section 4.4.3 for a complete explanation.
Of course, if a few or all page cross references are off,
they can be proofread and changed in the report by using
Framework's word processing.
ssing.
Page references
SCLaarea
.dme - intro "readme" text file that directs
you to read these instructions
SCLins
.fw3 - the auto install program
SCLms1
.fw3 - auto install pop-up instructions
SCLms2
.fw3 - basic instructions for a quick test run
SCLaltm
.fw3 - the invoking macro for your Library
SCLprg
.fw3 - the scan and clip program
SCLdoc
.FW3 - these instructions
8 SCL
.fw3 - a sample file to scan for a trial run
Files Included With SCLip.ARC - All must be installed on
your FW3 default drive and path change to be accurate
be install
; Scan & Clip
; by Gary Reger
;VERSION
90-07-23
; (c) copyright claimed
;..........................................
PLEASE REPORT ANY BUGS AND LET ME HAVE YOUR SUGGESTIONS,
Thanks,
Gary Reger, CIS # 72416,3377.
Version information